Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Audit for dimensionless.jl #13

Merged
merged 4 commits into from
Jan 3, 2025
Merged

Audit for dimensionless.jl #13

merged 4 commits into from
Jan 3, 2025

Conversation

adamslc
Copy link
Member

@adamslc adamslc commented Dec 30, 2024 •
edited
Loading

  • Item input/output uses Unitful.jl to keep track of units
  • Particle quantities can be specified using ChargedParticles.jl, if applicable
  • Arguments are order independent, or it is documented clearly that this is not the case
  • Output tested against known good examples, either using doctests or in the package tests
  • Output tested against plasmapy, if possible.
  • Docstring with a description of the physical meaning of the quantity, a doctest example, cross references, external references to e.g. Wikipedia, plasmapy, etc.
  • Item is included in the appropriate section of the docs.

@adamslc adamslc force-pushed the dimensionless branch 3 times, most recently from 9933a58 to b44fa45 Compare December 30, 2024 05:47
@adamslc adamslc merged commit d4ee6d8 into main Jan 3, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@adamslc